feat: mock_call with dynamic return data #2904

ptisserand · 2025-01-31T14:14:54Z

Closes #2861

Introduced changes

Add mock_call_when, start_mock_call_when and stop_mock_call_when to support "dynamic" return value when mocking a contract entry point.

Checklist

snforge_std/src/cheatcodes.cairo

Add `mock_call_when`, `start_mock_call_when` and `stop_mock_call_when`

…:TargetCalls is 0

cptartur · 2025-02-10T15:14:01Z

...heatnet/src/runtime_extensions/call_to_blockifier_runtime_extension/execution/entry_point.rs

+            let key_zero = (call.entry_point_selector, Felt::zero());
+
+            match contract_functions.get(&key) {
+                Some(CheatStatus::Cheated(_, CheatSpan::TargetCalls(0))) => {


After calling get_mocked_function_cheat_status, we call .decrement_cheat_span on the returned value. It changes the CheatSpan to Uncheated after it decreases to 0.

I don't think there can be a case where TargetCalls is equal to 0 unless explicitly set to this value somewhere.

I assume this logic match arm was added to handle the case where entrypoint for specific calldata is no longer cheated but for any calldata still is, but it should already be handled by _ case anyway.

Turns out technically it could be set to 0 but it shouldn't be allowed.

Created #2927

I'm not sure to understand what should I do here: remove my workaround?

You don't have to match for the case where cheat span is CheatSpan::TargetCalls(0). Technically, user could have somehow created it like this (as explained in #2927), but during normal operation it will either be CheatSpan::TargetCalls(some value > 0) or CheatStatus::Uncheated.

See this

starknet-foundry/crates/cheatnet/src/state.rs

Line 141 in f2e7d0d

pub fn decrement_cheat_span(&mut self) {

Workaround removed

crates/cheatnet/src/runtime_extensions/forge_runtime_extension/cheatcodes/mock_call.rs

cptartur · 2025-02-10T15:28:29Z

crates/forge/tests/integration/mock_call.rs

I think we should also have test cases where mock_call_when is mixed with mock_call, these are the ones most likely to break/have some weird edge cases.

docs/src/appendix/cheatcodes/mock_call_when.md

snforge_std/src/cheatcodes.cairo

- rename cairo MockCallData enum into MockCalldata - use Serde derivation for MockCalldata instead of custom serializer.

cptartur · 2025-02-28T09:52:21Z

crates/forge/tests/integration/mock_call.rs

+}
+
+#[test]
+fn mock_calls_when_mixed() {


Can we add some cases where the same tests uses both mock_call and mock_call_when?

E.g. in case where you do start_mock_call_when(MockCalldata::Any, ...) and then stop_mock_call(...) and similar?

github-actions · 2025-04-04T07:06:15Z

Hi! This pull request hasn't had any activity for a while, so I am
marking it as stale. It will close in 14
days if it is not updated. Thanks for contributing!

franciszekjob · 2025-04-07T00:52:15Z

Hey @ptisserand 👋 , are you going to continue working on this PR?

ptisserand · 2025-04-08T14:35:17Z

Hey @ptisserand 👋 , are you going to continue working on this PR?

Hi @franciszekjob, sorry I completely forgot about this PR when working on other projects :(
If it's not blocking on your side, I can work on it in the incoming week: what do you think ?

franciszekjob · 2025-04-15T10:27:38Z

@ptisserand sure thing, no hurry!

franciszekjob · 2025-05-13T10:20:10Z

Hi @ptisserand 👋 , kindly asking if there's any update on this?

…-call

cptartur · 2025-05-20T10:23:19Z

Hey @ptisserand is this ready for re-review?

ptisserand · 2025-05-22T13:22:10Z

Hey @ptisserand is this ready for re-review?

Not yet, I have only managed conflicts with master branch.
I didn't yet add requested additional test cases.

github-actions · 2025-06-23T07:07:23Z

Hi! This pull request hasn't had any activity for a while, so I am
marking it as stale. It will close in 14
days if it is not updated. Thanks for contributing!

franciszekjob · 2025-06-24T09:53:09Z

Hi @ptisserand 👋 , any update on this?

…-call

ptisserand · 2025-07-15T06:57:19Z

Hi @franciszekjob, I have added some tests cases.
I think this PR could be reviewed again.

…-call

ptisserand · 2025-08-26T15:01:36Z

Hi @cptartur @franciszekjob, could you please review this PR ?

franciszekjob · 2025-09-08T09:28:10Z

docs/src/appendix/cheatcodes/mock_call_when.md

+### `stop_mock_call_when`
+
+> `fn stop_mock_call_when(contract_address: ContractAddress, function_selector: felt252, calldata: MockCalldata)`


Suggested change

### `stop_mock_call_when`

> `fn stop_mock_call_when(contract_address: ContractAddress, function_selector: felt252, calldata: MockCalldata)`

## `stop_mock_call_when`

> `fn stop_mock_call_when(contract_address: ContractAddress, function_selector: felt252, calldata: MockCalldata)`

franciszekjob · 2025-09-08T09:43:27Z

CHANGELOG.md


 - Rust is no longer required to use `snforge` if using Scarb >= 2.10.0 on supported platforms - precompiled `snforge_scarb_plugin` plugin binaries are now published to [package registry](https://scarbs.xyz) for new versions.
 - Added a suggestion for using the `--max-n-steps` flag when the Cairo VM returns the error: `Could not reach the end of the program. RunResources has no remaining steps`.
+- `mock_call_when`, `start_mock_call_when`, `stop_mock_call_when` cheatcodes.


It should be under unreleased version.

franciszekjob · 2025-09-08T09:46:23Z

docs/src/appendix/cheatcodes/mock_call_when.md

@@ -0,0 +1,43 @@
+# `mock_call_when`
+
+Cheatcodes mocking contract entry point calls:


It's the same as description of mock_call. Maybe let's emphasize the difference?

Updated with Cheatcodes mocking contract entry point calls based on calldata:

franciszekjob · 2025-09-08T09:51:10Z

docs/src/appendix/cheatcodes/mock_call_when.md

It would be really nice to add an example of usage, similarly how it's done here 😄
You can create and issue for that, link it here and if you have time open - a separate PR.

…-call

ptisserand force-pushed the feat/dynamic-mock-call branch from 0a08540 to d75e50b Compare January 31, 2025 17:21

cptartur reviewed Feb 3, 2025

View reviewed changes

snforge_std/src/cheatcodes.cairo Show resolved Hide resolved

ptisserand marked this pull request as ready for review February 4, 2025 00:23

ptisserand requested review from ddoktorski and kkawula as code owners February 4, 2025 00:23

ptisserand added 8 commits February 4, 2025 15:07

feat(snforge_std): add "dynamic" return value for mock_call

0ff1663

feat(cheatnet): add "dynamic" return value fir mock_call

f21e510

forge: update test to support new mock_call cheatcode

3c37814

fix mock_call test

d1921ea

cheatnet: fixup clippy

9594b5a

snforge_std: revert breaking changes on mock_call

c097e3c

Add `mock_call_when`, `start_mock_call_when` and `stop_mock_call_when`

fix(cheatnet): default to any calldata entry when specific CheatSpan:…

e70b4b1

…:TargetCalls is 0

docs: add mock_call_when cheatcode

02a7dcd

ptisserand force-pushed the feat/dynamic-mock-call branch from 89e963b to 02a7dcd Compare February 4, 2025 14:33

cptartur requested changes Feb 10, 2025

View reviewed changes

ptisserand added 2 commits February 12, 2025 00:06

use calldata instead of call_data

3498701

cheatnet: add MockCalldata enum

f4bc282

- rename cairo MockCallData enum into MockCalldata - use Serde derivation for MockCalldata instead of custom serializer.

ptisserand requested a review from a team as a code owner February 18, 2025 02:59

cptartur reviewed Feb 28, 2025

View reviewed changes

cptartur requested a review from franciszekjob March 4, 2025 11:17

github-actions bot added the stale Stale Bot label Apr 4, 2025

github-actions bot removed the stale Stale Bot label Apr 7, 2025

ptisserand added 3 commits April 30, 2025 19:31

Merge remote-tracking branch 'upstream/master'

e15e00f

fix: add missing argument for run_test_case

90cff00

scarb fmt

2cd43a4

ptisserand added 2 commits May 17, 2025 10:34

Merge remote-tracking branch 'upstream/master' into feat/dynamic-mock…

e1293a8

…-call

remove workaround for foundry-rs#2927

2c5ec93

github-actions bot added the stale Stale Bot label Jun 23, 2025

github-actions bot removed the stale Stale Bot label Jun 25, 2025

ptisserand added 3 commits July 15, 2025 08:31

add test cases with interleaved start/stop mock_call and mock_call_when

3aeb496

Merge remote-tracking branch 'upstream/master' into feat/dynamic-mock…

1a20bbd

…-call

cargo fmt

f235bd7

ptisserand requested a review from cptartur July 15, 2025 06:57

ptisserand added 3 commits August 6, 2025 00:36

Merge remote-tracking branch 'upstream/master' into master-merged

da9bc28

add missing use for cheatcodes

3ae2a28

Merge remote-tracking branch 'upstream/master' into feat/dynamic-mock…

7bbed0d

…-call

franciszekjob reviewed Sep 8, 2025

View reviewed changes

ptisserand added 3 commits September 16, 2025 10:33

docs: apply PR suggestion

02604f9

Merge remote-tracking branch 'upstream/master' into feat/dynamic-mock…

9a93ca3

…-call

update CHANGELOG

86811c8

cptartur removed request for ddoktorski and kkawula September 17, 2025 13:05

cptartur assigned cptartur and franciszekjob Sep 17, 2025

		### `stop_mock_call_when`

		> `fn stop_mock_call_when(contract_address: ContractAddress, function_selector: felt252, calldata: MockCalldata)`

		@@ -0,0 +1,43 @@
		# `mock_call_when`

		Cheatcodes mocking contract entry point calls:

feat: mock_call with dynamic return data #2904

Are you sure you want to change the base?

feat: mock_call with dynamic return data #2904

Uh oh!

Conversation

ptisserand commented Jan 31, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Introduced changes

Checklist

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

github-actions bot commented Apr 4, 2025

Uh oh!

franciszekjob commented Apr 7, 2025

Uh oh!

ptisserand commented Apr 8, 2025

Uh oh!

franciszekjob commented Apr 15, 2025

Uh oh!

franciszekjob commented May 13, 2025

Uh oh!

cptartur commented May 20, 2025

Uh oh!

ptisserand commented May 22, 2025

Uh oh!

github-actions bot commented Jun 23, 2025

Uh oh!

franciszekjob commented Jun 24, 2025

Uh oh!

ptisserand commented Jul 15, 2025

Uh oh!

ptisserand commented Aug 26, 2025

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

ptisserand commented Jan 31, 2025 •

edited

Loading